-
Notifications
You must be signed in to change notification settings - Fork 54
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updating the node operator guide #231
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
6fdc83c
to
1e4e64f
Compare
I would suggest to reference the observer node as "Light Node" (not "light client"). To the best of my knowledge, there is no properly defined terminology. However, in the context of Flow, there is an important differentiation between what I call a light node vs a light client: Light Node (previously called Observer)
From a software perspective, the Light Node is quite similar to the archive node (store and index blocks, store and index execution state), except that is does not exhaustively replicate the entire execution state and does not commit to keeping a super-long history . Light Client
More details on light clients:
Context:
|
@@ -1,25 +1,25 @@ | |||
--- | |||
title: Observer Node | |||
sidebar_label: Observer Node | |||
title: Light Client a.k.a Observer Node |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see preview here
@@ -20,15 +20,32 @@ Flow multirole architecture makes it more scalable and provides several node typ | |||
|
|||
The different types of nodes are described [here](./node-roles.mdx). As node operator, you can choose to run any of the different types of node that best fits your needs. | |||
|
|||
### Observer node | |||
The observer node is one of the easiest node to spin up and can be run by Dapp developers who need the latest block data available locally e.g. a wallet application that needs to track the latest block ID and height. | |||
## Light client a.k.a. Observer node |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see a preview of this page here
❤️ thank you for this explanation - will change |
Co-authored-by: Alexander Hentschel <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What so you think about the following revision of line 52, which currently reads:
An access node is staked but since it does not participate in the core Flow protocol, it does not receive any staking rewards.
I would suggest to revise this to (edits highlighted in bold):
An access node is minimally staked for network security. Nevertheless, the central goal for Access Nodes is to provide functionality to its node operator. In comparison, contributing to protocol progress (e.g. routing transactions to collector clusters, relaying blocks to the unstaked peer-to-peer network, etc.) should only take up a marginal fraction an Access Node's computational resources. Furthermore, Access Node operators can freely rate-limit the amount of resources their Access Node dedicates to supporting the broader ecosystem. Therefore, Access Nodes do not receive staking rewards.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
made that change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
few more wording suggestions. Nothing major. Thanks for the update! Nice work 👏
@@ -1,25 +1,25 @@ | |||
--- | |||
title: Observer Node | |||
sidebar_label: Observer Node | |||
title: Light Client a.k.a Observer Node |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
still using term "Light client" in this doc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed a couple small typos, but otherwise it looks good
Co-authored-by: Peter Argue <[email protected]>
Co-authored-by: Peter Argue <[email protected]>
Co-authored-by: Alexander Hentschel <[email protected]>
Co-authored-by: Peter Argue <[email protected]>
Co-authored-by: Alexander Hentschel <[email protected]>
Co-authored-by: Alexander Hentschel <[email protected]>
@AlexHentschel @peterargue - Just wanted to call out - I am intentionally avoiding the phrase light node |
This PR updates the node operator to make the Flow node nomenclature closer to Ethereum to allow folks from the Ethereum community to be able to easily understand the different Flow node types.
Light Client.Light Node (based on explanation from Alex)The mental model I had is:
(Flow.com will have additional changes to describe how run a node at a much higher level with a call to action pointing to this page)